Add docs links to helm NOTES.txt #4953
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jjngx
approved these changes
Jan 22, 2024
vepatel
approved these changes
Jan 22, 2024
pdabelf5
approved these changes
Jan 22, 2024
vepatel
reviewed
Jan 22, 2024
github-actions
bot
added
the
documentation
Contributor
|
@oseoin is it possible to add these instructions while running |
ADubhlaoich
approved these changes
Jan 22, 2024
Member
ADubhlaoich
left a comment
ADubhlaoich
left a comment
There was a problem hiding this comment.
LGTM: made a few edit suggestions around noun use for NGINX Ingress Controller.
docs/content/installation/installing-nic/installation-with-helm.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alan Dooley <a.dooley@f5.com> Signed-off-by: oseoin <oseoin@users.noreply.github.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4953 +/- ##
==========================================
- Coverage 52.31% 52.28% -0.03%
==========================================
Files 60 60
Lines 17501 17501
==========================================
- Hits 9155 9151 -4
- Misses 8018 8020 +2
- Partials 328 330 +2 ☔ View full report in Codecov by Sentry. |
…m.md Co-authored-by: Alan Dooley <a.dooley@f5.com> Signed-off-by: oseoin <oseoin@users.noreply.github.com>
Contributor
Author
@vepatel can confirm it works with helm upgrade my-release charts/nginx-ingress --dry-run
walk.go:74: found symbolic link in path: /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/charts/nginx-ingress/crds resolves to /Users/e.oshaughnessy/github/nginxinc/kubernetes-ingress/config/crd/bases. Contents of linked file included and used
Release "my-release" has been upgraded. Happy Helming!
NAME: my-release
LAST DEPLOYED: Mon Jan 22 10:38:57 2024
NAMESPACE: default
STATUS: pending-upgrade
REVISION: 3
TEST SUITE: None
HOOKS:
MANIFEST:
---
# Source: nginx-ingress/templates/controller-serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
name: my-release-nginx-ingress
namespace: default
...
NOTES:
The NGINX Ingress Controller 3.4.0 has been installed.
For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/
If you are upgrading from a version of the chart that uses older Custom Resource Definitions (CRD) it is necessary to manually upgrade the CRDs as this is not managed by Helm.
To update to the latest version of the CRDs:
$ kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.0/deploy/crds.yaml
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds |
Co-authored-by: Alan Dooley <a.dooley@f5.com> Signed-off-by: oseoin <oseoin@users.noreply.github.com>
j1m-ryan
approved these changes
Jan 22, 2024
oseoin
added a commit
that referenced
this pull request
Feb 12, 2024
* add docs links to helm NOTES.txt
oseoin
added a commit
that referenced
this pull request
Feb 12, 2024
Add docs links to helm NOTES.txt (#4953)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Add links to installation and upgrade documentation to Helm NOTES.txt, along with a note on CRD upgrades.
Before:
After - Install:
After - Upgrade:
Checklist
Before creating a PR, run through this checklist and mark each as complete.